﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class DurableOrchestrationClient
   </title>
    <!-- Prevent search engine web crawlers from indexing or crawling this page -->
    <meta name="robots" content="none">
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class DurableOrchestrationClient
   ">
    <meta name="generator" content="docfx 2.40.12.0">
    
    <link rel="shortcut icon" href="../favicon.ico">
    <link rel="stylesheet" href="../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../styles/docfx.css">
    <link rel="stylesheet" href="../styles/main.css">
    <meta property="docfx:navrel" content="../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
    
    
  </head>
  <body data-spy="scroll" data-target="#affix">
    <div id="wrapper">
      <header>
        
        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>
              
              <a class="navbar-brand" href="../index.html">
                <img id="logo" class="svg" src="../logo.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>
        
        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient">
  
  
  <h1 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient" class="text-break">Class DurableOrchestrationClient
  </h1>
  <div class="markdown level0 summary"><p>Client for starting, querying, terminating, and raising events to orchestration instances.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><span class="xref">System.Object</span></div>
    <div class="level1"><a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html">DurableOrchestrationClientBase</a></div>
    <div class="level2"><span class="xref">DurableOrchestrationClient</span></div>
  </div>
  <div class="inheritedMembers">
    <h5>Inherited Members</h5>
    <div>
      <a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_WaitForCompletionOrCreateCheckStatusResponseAsync_System_Net_Http_HttpRequestMessage_System_String_">DurableOrchestrationClientBase.WaitForCompletionOrCreateCheckStatusResponseAsync(HttpRequestMessage, String)</a>
    </div>
    <div>
      <a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_WaitForCompletionOrCreateCheckStatusResponseAsync_System_Net_Http_HttpRequestMessage_System_String_System_TimeSpan_">DurableOrchestrationClientBase.WaitForCompletionOrCreateCheckStatusResponseAsync(HttpRequestMessage, String, TimeSpan)</a>
    </div>
    <div>
      <a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_StartNewAsync_System_String_System_Object_">DurableOrchestrationClientBase.StartNewAsync(String, Object)</a>
    </div>
    <div>
      <a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_RaiseEventAsync_System_String_System_String_">DurableOrchestrationClientBase.RaiseEventAsync(String, String)</a>
    </div>
    <div>
      <a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_GetStatusAsync_System_String_">DurableOrchestrationClientBase.GetStatusAsync(String)</a>
    </div>
    <div>
      <a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_GetStatusAsync_System_String_System_Boolean_">DurableOrchestrationClientBase.GetStatusAsync(String, Boolean)</a>
    </div>
    <div>
      <span class="xref">System.Object.Equals(System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.GetHashCode()</span>
    </div>
    <div>
      <span class="xref">System.Object.GetType()</span>
    </div>
    <div>
      <span class="xref">System.Object.MemberwiseClone()</span>
    </div>
    <div>
      <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.ToString()</span>
    </div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="Microsoft.Azure.WebJobs.html">Microsoft.Azure.WebJobs</a></h6>
  <h6><strong>Assembly</strong>: Microsoft.Azure.WebJobs.Extensions.DurableTask.dll</h6>
  <h5 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class DurableOrchestrationClient : DurableOrchestrationClientBase</code></pre>
  </div>
  <h3 id="properties">Properties
  </h3>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/Azure/azure-functions-durable-extension/new/master/apiSpec/new?filename=Microsoft_Azure_WebJobs_DurableOrchestrationClient_TaskHubName.md&amp;value=---%0Auid%3A%20Microsoft.Azure.WebJobs.DurableOrchestrationClient.TaskHubName%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/Azure/azure-functions-durable-extension/blob/master/src/WebJobs.Extensions.DurableTask/DurableOrchestrationClient.cs/#L49">View Source</a>
  </span>
  <a id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_TaskHubName_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.TaskHubName*"></a>
  <h4 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_TaskHubName" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.TaskHubName">TaskHubName</h4>
  <div class="markdown level1 summary"><p>Gets the name of the task hub configured on this client instance.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override string TaskHubName { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><p>The name of the task hub.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_TaskHubName">DurableOrchestrationClientBase.TaskHubName</a></div>
  <h3 id="methods">Methods
  </h3>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/Azure/azure-functions-durable-extension/new/master/apiSpec/new?filename=Microsoft_Azure_WebJobs_DurableOrchestrationClient_CreateCheckStatusResponse_System_Net_Http_HttpRequestMessage_System_String_.md&amp;value=---%0Auid%3A%20Microsoft.Azure.WebJobs.DurableOrchestrationClient.CreateCheckStatusResponse(System.Net.Http.HttpRequestMessage%2CSystem.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/Azure/azure-functions-durable-extension/blob/master/src/WebJobs.Extensions.DurableTask/DurableOrchestrationClient.cs/#L52">View Source</a>
  </span>
  <a id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_CreateCheckStatusResponse_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.CreateCheckStatusResponse*"></a>
  <h4 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_CreateCheckStatusResponse_System_Net_Http_HttpRequestMessage_System_String_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.CreateCheckStatusResponse(System.Net.Http.HttpRequestMessage,System.String)">CreateCheckStatusResponse(HttpRequestMessage, String)</h4>
  <div class="markdown level1 summary"><p>Creates an HTTP response that is useful for checking the status of the specified instance.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override HttpResponseMessage CreateCheckStatusResponse(HttpRequestMessage request, string instanceId)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Net.Http.HttpRequestMessage</span></td>
        <td><span class="parametername">request</span></td>
        <td><p>The HTTP request that triggered the current orchestration instance.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">instanceId</span></td>
        <td><p>The ID of the orchestration instance to check.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Net.Http.HttpResponseMessage</span></td>
        <td><p>An HTTP 202 response with a Location header and a payload containing instance control URLs.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_CreateCheckStatusResponse_System_Net_Http_HttpRequestMessage_System_String_">DurableOrchestrationClientBase.CreateCheckStatusResponse(HttpRequestMessage, String)</a></div>
  <h5 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_CreateCheckStatusResponse_System_Net_Http_HttpRequestMessage_System_String__remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>The payload of the returned <span class="xref">System.Net.Http.HttpResponseMessage</span> contains HTTP API URLs that can
be used to query the status of the orchestration, raise events to the orchestration, or
terminate the orchestration.</p>
</div>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/Azure/azure-functions-durable-extension/new/master/apiSpec/new?filename=Microsoft_Azure_WebJobs_DurableOrchestrationClient_CreateHttpManagementPayload_System_String_.md&amp;value=---%0Auid%3A%20Microsoft.Azure.WebJobs.DurableOrchestrationClient.CreateHttpManagementPayload(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/Azure/azure-functions-durable-extension/blob/master/src/WebJobs.Extensions.DurableTask/DurableOrchestrationClient.cs/#L58">View Source</a>
  </span>
  <a id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_CreateHttpManagementPayload_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.CreateHttpManagementPayload*"></a>
  <h4 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_CreateHttpManagementPayload_System_String_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.CreateHttpManagementPayload(System.String)">CreateHttpManagementPayload(String)</h4>
  <div class="markdown level1 summary"><p>Creates a <a class="xref" href="Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpManagementPayload.html">HttpManagementPayload</a> object that contains status, terminate and send external event HTTP endpoints.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override HttpManagementPayload CreateHttpManagementPayload(string instanceId)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">instanceId</span></td>
        <td><p>The ID of the orchestration instance to check.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpManagementPayload.html">HttpManagementPayload</a></td>
        <td><p>Instance of the <a class="xref" href="Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpManagementPayload.html">HttpManagementPayload</a> class.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_CreateHttpManagementPayload_System_String_">DurableOrchestrationClientBase.CreateHttpManagementPayload(String)</a></div>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/Azure/azure-functions-durable-extension/new/master/apiSpec/new?filename=Microsoft_Azure_WebJobs_DurableOrchestrationClient_GetStatusAsync_System_DateTime_System_Nullable_System_DateTime__System_Collections_Generic_IEnumerable_Microsoft_Azure_WebJobs_OrchestrationRuntimeStatus__System_Int32_System_String_System_Threading_CancellationToken_.md&amp;value=---%0Auid%3A%20Microsoft.Azure.WebJobs.DurableOrchestrationClient.GetStatusAsync(System.DateTime%2CSystem.Nullable%7BSystem.DateTime%7D%2CSystem.Collections.Generic.IEnumerable%7BMicrosoft.Azure.WebJobs.OrchestrationRuntimeStatus%7D%2CSystem.Int32%2CSystem.String%2CSystem.Threading.CancellationToken)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/Azure/azure-functions-durable-extension/blob/master/src/WebJobs.Extensions.DurableTask/DurableOrchestrationClient.cs/#L251">View Source</a>
  </span>
  <a id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_GetStatusAsync_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.GetStatusAsync*"></a>
  <h4 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_GetStatusAsync_System_DateTime_System_Nullable_System_DateTime__System_Collections_Generic_IEnumerable_Microsoft_Azure_WebJobs_OrchestrationRuntimeStatus__System_Int32_System_String_System_Threading_CancellationToken_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.GetStatusAsync(System.DateTime,System.Nullable{System.DateTime},System.Collections.Generic.IEnumerable{Microsoft.Azure.WebJobs.OrchestrationRuntimeStatus},System.Int32,System.String,System.Threading.CancellationToken)">GetStatusAsync(DateTime, Nullable&lt;DateTime&gt;, IEnumerable&lt;OrchestrationRuntimeStatus&gt;, Int32, String, CancellationToken)</h4>
  <div class="markdown level1 summary"><p>Gets the status of all orchestration instances with paging that match the specified conditions.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override Task&lt;OrchestrationStatusQueryResult&gt; GetStatusAsync(DateTime createdTimeFrom, DateTime? createdTimeTo, IEnumerable&lt;OrchestrationRuntimeStatus&gt; runtimeStatus, int pageSize, string continuationToken, CancellationToken cancellationToken = default(CancellationToken))</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.DateTime</span></td>
        <td><span class="parametername">createdTimeFrom</span></td>
        <td><p>Return orchestration instances which were created after this DateTime.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.DateTime</span>&gt;</td>
        <td><span class="parametername">createdTimeTo</span></td>
        <td><p>Return orchestration instances which were created before this DateTime.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<a class="xref" href="Microsoft.Azure.WebJobs.OrchestrationRuntimeStatus.html">OrchestrationRuntimeStatus</a>&gt;</td>
        <td><span class="parametername">runtimeStatus</span></td>
        <td><p>Return orchestration instances which matches the runtimeStatus.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td><span class="parametername">pageSize</span></td>
        <td><p>Number of records per one request.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">continuationToken</span></td>
        <td><p>ContinuationToken of the pager.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Threading.CancellationToken</span></td>
        <td><span class="parametername">cancellationToken</span></td>
        <td><p>Cancellation token that can be used to cancel the status query operation.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Threading.Tasks.Task</span>&lt;<a class="xref" href="Microsoft.Azure.WebJobs.Extensions.DurableTask.OrchestrationStatusQueryResult.html">OrchestrationStatusQueryResult</a>&gt;</td>
        <td><p>Returns each page of orchestration status for all instances and continuation token of next page.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_GetStatusAsync_System_DateTime_System_Nullable_System_DateTime__System_Collections_Generic_IEnumerable_Microsoft_Azure_WebJobs_OrchestrationRuntimeStatus__System_Int32_System_String_System_Threading_CancellationToken_">DurableOrchestrationClientBase.GetStatusAsync(DateTime, Nullable&lt;DateTime&gt;, IEnumerable&lt;OrchestrationRuntimeStatus&gt;, Int32, String, CancellationToken)</a></div>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/Azure/azure-functions-durable-extension/new/master/apiSpec/new?filename=Microsoft_Azure_WebJobs_DurableOrchestrationClient_GetStatusAsync_System_DateTime_System_Nullable_System_DateTime__System_Collections_Generic_IEnumerable_Microsoft_Azure_WebJobs_OrchestrationRuntimeStatus__System_Threading_CancellationToken_.md&amp;value=---%0Auid%3A%20Microsoft.Azure.WebJobs.DurableOrchestrationClient.GetStatusAsync(System.DateTime%2CSystem.Nullable%7BSystem.DateTime%7D%2CSystem.Collections.Generic.IEnumerable%7BMicrosoft.Azure.WebJobs.OrchestrationRuntimeStatus%7D%2CSystem.Threading.CancellationToken)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/Azure/azure-functions-durable-extension/blob/master/src/WebJobs.Extensions.DurableTask/DurableOrchestrationClient.cs/#L216">View Source</a>
  </span>
  <a id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_GetStatusAsync_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.GetStatusAsync*"></a>
  <h4 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_GetStatusAsync_System_DateTime_System_Nullable_System_DateTime__System_Collections_Generic_IEnumerable_Microsoft_Azure_WebJobs_OrchestrationRuntimeStatus__System_Threading_CancellationToken_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.GetStatusAsync(System.DateTime,System.Nullable{System.DateTime},System.Collections.Generic.IEnumerable{Microsoft.Azure.WebJobs.OrchestrationRuntimeStatus},System.Threading.CancellationToken)">GetStatusAsync(DateTime, Nullable&lt;DateTime&gt;, IEnumerable&lt;OrchestrationRuntimeStatus&gt;, CancellationToken)</h4>
  <div class="markdown level1 summary"><p>Gets the status of all orchestration instances that match the specified conditions.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override Task&lt;IList&lt;DurableOrchestrationStatus&gt;&gt; GetStatusAsync(DateTime createdTimeFrom, DateTime? createdTimeTo, IEnumerable&lt;OrchestrationRuntimeStatus&gt; runtimeStatus, CancellationToken cancellationToken = default(CancellationToken))</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.DateTime</span></td>
        <td><span class="parametername">createdTimeFrom</span></td>
        <td><p>Return orchestration instances which were created after this DateTime.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.DateTime</span>&gt;</td>
        <td><span class="parametername">createdTimeTo</span></td>
        <td><p>Return orchestration instances which were created before this DateTime.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<a class="xref" href="Microsoft.Azure.WebJobs.OrchestrationRuntimeStatus.html">OrchestrationRuntimeStatus</a>&gt;</td>
        <td><span class="parametername">runtimeStatus</span></td>
        <td><p>Return orchestration instances which matches the runtimeStatus.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Threading.CancellationToken</span></td>
        <td><span class="parametername">cancellationToken</span></td>
        <td><p>Cancellation token that can be used to cancel the status query operation.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Threading.Tasks.Task</span>&lt;<span class="xref">System.Collections.Generic.IList</span>&lt;<a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationStatus.html">DurableOrchestrationStatus</a>&gt;&gt;</td>
        <td><p>Returns orchestration status for all instances.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_GetStatusAsync_System_DateTime_System_Nullable_System_DateTime__System_Collections_Generic_IEnumerable_Microsoft_Azure_WebJobs_OrchestrationRuntimeStatus__System_Threading_CancellationToken_">DurableOrchestrationClientBase.GetStatusAsync(DateTime, Nullable&lt;DateTime&gt;, IEnumerable&lt;OrchestrationRuntimeStatus&gt;, CancellationToken)</a></div>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/Azure/azure-functions-durable-extension/new/master/apiSpec/new?filename=Microsoft_Azure_WebJobs_DurableOrchestrationClient_GetStatusAsync_System_String_System_Boolean_System_Boolean_System_Boolean_.md&amp;value=---%0Auid%3A%20Microsoft.Azure.WebJobs.DurableOrchestrationClient.GetStatusAsync(System.String%2CSystem.Boolean%2CSystem.Boolean%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/Azure/azure-functions-durable-extension/blob/master/src/WebJobs.Extensions.DurableTask/DurableOrchestrationClient.cs/#L184">View Source</a>
  </span>
  <a id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_GetStatusAsync_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.GetStatusAsync*"></a>
  <h4 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_GetStatusAsync_System_String_System_Boolean_System_Boolean_System_Boolean_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.GetStatusAsync(System.String,System.Boolean,System.Boolean,System.Boolean)">GetStatusAsync(String, Boolean, Boolean, Boolean)</h4>
  <div class="markdown level1 summary"><p>Gets the status of the specified orchestration instance.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override Task&lt;DurableOrchestrationStatus&gt; GetStatusAsync(string instanceId, bool showHistory = false, bool showHistoryOutput = false, bool showInput = true)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">instanceId</span></td>
        <td><p>The ID of the orchestration instance to query.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Boolean</span></td>
        <td><span class="parametername">showHistory</span></td>
        <td><p>Boolean marker for including execution history in the response.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Boolean</span></td>
        <td><span class="parametername">showHistoryOutput</span></td>
        <td><p>Boolean marker for including input and output in the execution history response.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Boolean</span></td>
        <td><span class="parametername">showInput</span></td>
        <td><p>If set, fetch and return the input for the orchestration instance.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Threading.Tasks.Task</span>&lt;<a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationStatus.html">DurableOrchestrationStatus</a>&gt;</td>
        <td><p>Returns a task which completes when the status has been fetched.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_GetStatusAsync_System_String_System_Boolean_System_Boolean_System_Boolean_">DurableOrchestrationClientBase.GetStatusAsync(String, Boolean, Boolean, Boolean)</a></div>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/Azure/azure-functions-durable-extension/new/master/apiSpec/new?filename=Microsoft_Azure_WebJobs_DurableOrchestrationClient_GetStatusAsync_System_Threading_CancellationToken_.md&amp;value=---%0Auid%3A%20Microsoft.Azure.WebJobs.DurableOrchestrationClient.GetStatusAsync(System.Threading.CancellationToken)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/Azure/azure-functions-durable-extension/blob/master/src/WebJobs.Extensions.DurableTask/DurableOrchestrationClient.cs/#L200">View Source</a>
  </span>
  <a id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_GetStatusAsync_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.GetStatusAsync*"></a>
  <h4 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_GetStatusAsync_System_Threading_CancellationToken_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.GetStatusAsync(System.Threading.CancellationToken)">GetStatusAsync(CancellationToken)</h4>
  <div class="markdown level1 summary"><p>Gets all the status of the orchestration instances.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override Task&lt;IList&lt;DurableOrchestrationStatus&gt;&gt; GetStatusAsync(CancellationToken cancellationToken = default(CancellationToken))</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Threading.CancellationToken</span></td>
        <td><span class="parametername">cancellationToken</span></td>
        <td><p>Cancellation token that can be used to cancel the status query operation.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Threading.Tasks.Task</span>&lt;<span class="xref">System.Collections.Generic.IList</span>&lt;<a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationStatus.html">DurableOrchestrationStatus</a>&gt;&gt;</td>
        <td><p>Returns orchestration status for all instances.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_GetStatusAsync_System_Threading_CancellationToken_">DurableOrchestrationClientBase.GetStatusAsync(CancellationToken)</a></div>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/Azure/azure-functions-durable-extension/new/master/apiSpec/new?filename=Microsoft_Azure_WebJobs_DurableOrchestrationClient_PurgeInstanceHistoryAsync_System_DateTime_System_Nullable_System_DateTime__System_Collections_Generic_IEnumerable_DurableTask_Core_OrchestrationStatus__.md&amp;value=---%0Auid%3A%20Microsoft.Azure.WebJobs.DurableOrchestrationClient.PurgeInstanceHistoryAsync(System.DateTime%2CSystem.Nullable%7BSystem.DateTime%7D%2CSystem.Collections.Generic.IEnumerable%7BDurableTask.Core.OrchestrationStatus%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/Azure/azure-functions-durable-extension/blob/master/src/WebJobs.Extensions.DurableTask/DurableOrchestrationClient.cs/#L241">View Source</a>
  </span>
  <a id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_PurgeInstanceHistoryAsync_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.PurgeInstanceHistoryAsync*"></a>
  <h4 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_PurgeInstanceHistoryAsync_System_DateTime_System_Nullable_System_DateTime__System_Collections_Generic_IEnumerable_DurableTask_Core_OrchestrationStatus__" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.PurgeInstanceHistoryAsync(System.DateTime,System.Nullable{System.DateTime},System.Collections.Generic.IEnumerable{DurableTask.Core.OrchestrationStatus})">PurgeInstanceHistoryAsync(DateTime, Nullable&lt;DateTime&gt;, IEnumerable&lt;OrchestrationStatus&gt;)</h4>
  <div class="markdown level1 summary"><p>Purge the orchestration history for instances that match the conditions.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override Task&lt;PurgeHistoryResult&gt; PurgeInstanceHistoryAsync(DateTime createdTimeFrom, DateTime? createdTimeTo, IEnumerable&lt;OrchestrationStatus&gt; runtimeStatus)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.DateTime</span></td>
        <td><span class="parametername">createdTimeFrom</span></td>
        <td><p>Start creation time for querying instances for purging.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.DateTime</span>&gt;</td>
        <td><span class="parametername">createdTimeTo</span></td>
        <td><p>End creation time for querying instances for purging.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<span class="xref">DurableTask.Core.OrchestrationStatus</span>&gt;</td>
        <td><span class="parametername">runtimeStatus</span></td>
        <td><p>List of runtime status for querying instances for purging. Only Completed, Terminated, or Failed will be processed.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Threading.Tasks.Task</span>&lt;<a class="xref" href="Microsoft.Azure.WebJobs.PurgeHistoryResult.html">PurgeHistoryResult</a>&gt;</td>
        <td><p>Returns an instance of <a class="xref" href="Microsoft.Azure.WebJobs.PurgeHistoryResult.html">PurgeHistoryResult</a>.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_PurgeInstanceHistoryAsync_System_DateTime_System_Nullable_System_DateTime__System_Collections_Generic_IEnumerable_DurableTask_Core_OrchestrationStatus__">DurableOrchestrationClientBase.PurgeInstanceHistoryAsync(DateTime, Nullable&lt;DateTime&gt;, IEnumerable&lt;OrchestrationStatus&gt;)</a></div>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/Azure/azure-functions-durable-extension/new/master/apiSpec/new?filename=Microsoft_Azure_WebJobs_DurableOrchestrationClient_PurgeInstanceHistoryAsync_System_String_.md&amp;value=---%0Auid%3A%20Microsoft.Azure.WebJobs.DurableOrchestrationClient.PurgeInstanceHistoryAsync(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/Azure/azure-functions-durable-extension/blob/master/src/WebJobs.Extensions.DurableTask/DurableOrchestrationClient.cs/#L231">View Source</a>
  </span>
  <a id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_PurgeInstanceHistoryAsync_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.PurgeInstanceHistoryAsync*"></a>
  <h4 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_PurgeInstanceHistoryAsync_System_String_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.PurgeInstanceHistoryAsync(System.String)">PurgeInstanceHistoryAsync(String)</h4>
  <div class="markdown level1 summary"><p>Purge the history for a concrete instance.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override Task&lt;PurgeHistoryResult&gt; PurgeInstanceHistoryAsync(string instanceId)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">instanceId</span></td>
        <td><p>The ID of the orchestration instance to purge.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Threading.Tasks.Task</span>&lt;<a class="xref" href="Microsoft.Azure.WebJobs.PurgeHistoryResult.html">PurgeHistoryResult</a>&gt;</td>
        <td><p>Returns an instance of <a class="xref" href="Microsoft.Azure.WebJobs.PurgeHistoryResult.html">PurgeHistoryResult</a>.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_PurgeInstanceHistoryAsync_System_String_">DurableOrchestrationClientBase.PurgeInstanceHistoryAsync(String)</a></div>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/Azure/azure-functions-durable-extension/new/master/apiSpec/new?filename=Microsoft_Azure_WebJobs_DurableOrchestrationClient_RaiseEventAsync_System_String_System_String_System_Object_.md&amp;value=---%0Auid%3A%20Microsoft.Azure.WebJobs.DurableOrchestrationClient.RaiseEventAsync(System.String%2CSystem.String%2CSystem.Object)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/Azure/azure-functions-durable-extension/blob/master/src/WebJobs.Extensions.DurableTask/DurableOrchestrationClient.cs/#L109">View Source</a>
  </span>
  <a id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_RaiseEventAsync_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.RaiseEventAsync*"></a>
  <h4 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_RaiseEventAsync_System_String_System_String_System_Object_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.RaiseEventAsync(System.String,System.String,System.Object)">RaiseEventAsync(String, String, Object)</h4>
  <div class="markdown level1 summary"><p>Sends an event notification message to a waiting orchestration instance.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override Task RaiseEventAsync(string instanceId, string eventName, object eventData)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">instanceId</span></td>
        <td><p>The ID of the orchestration instance that will handle the event.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">eventName</span></td>
        <td><p>The name of the event.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Object</span></td>
        <td><span class="parametername">eventData</span></td>
        <td><p>The JSON-serializeable data associated with the event.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Threading.Tasks.Task</span></td>
        <td><p>A task that completes when the event notification message has been enqueued.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_RaiseEventAsync_System_String_System_String_System_Object_">DurableOrchestrationClientBase.RaiseEventAsync(String, String, Object)</a></div>
  <h5 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_RaiseEventAsync_System_String_System_String_System_Object__remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>
In order to handle the event, the target orchestration instance must be waiting for an
event named <code data-dev-comment-type="paramref" class="paramref">eventName</code> using the
<a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationContext.html#Microsoft_Azure_WebJobs_DurableOrchestrationContext_WaitForExternalEvent__1_System_String_">WaitForExternalEvent&lt;T&gt;(String)</a> API.
</p><p>
If the specified instance is not found or not running, this operation will have no effect.
</p>
</div>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/Azure/azure-functions-durable-extension/new/master/apiSpec/new?filename=Microsoft_Azure_WebJobs_DurableOrchestrationClient_RaiseEventAsync_System_String_System_String_System_String_System_Object_System_String_.md&amp;value=---%0Auid%3A%20Microsoft.Azure.WebJobs.DurableOrchestrationClient.RaiseEventAsync(System.String%2CSystem.String%2CSystem.String%2CSystem.Object%2CSystem.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/Azure/azure-functions-durable-extension/blob/master/src/WebJobs.Extensions.DurableTask/DurableOrchestrationClient.cs/#L121">View Source</a>
  </span>
  <a id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_RaiseEventAsync_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.RaiseEventAsync*"></a>
  <h4 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_RaiseEventAsync_System_String_System_String_System_String_System_Object_System_String_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.RaiseEventAsync(System.String,System.String,System.String,System.Object,System.String)">RaiseEventAsync(String, String, String, Object, String)</h4>
  <div class="markdown level1 summary"><p>Sends an event notification message to a waiting orchestration instance.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override Task RaiseEventAsync(string taskHubName, string instanceId, string eventName, object eventData, string connectionName = null)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">taskHubName</span></td>
        <td><p>The TaskHubName of the orchestration that will handle the event.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">instanceId</span></td>
        <td><p>The ID of the orchestration instance that will handle the event.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">eventName</span></td>
        <td><p>The name of the event.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Object</span></td>
        <td><span class="parametername">eventData</span></td>
        <td><p>The JSON-serializeable data associated with the event.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">connectionName</span></td>
        <td><p>The name of the connection string associated with <code data-dev-comment-type="paramref" class="paramref">taskHubName</code>.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Threading.Tasks.Task</span></td>
        <td><p>A task that completes when the event notification message has been enqueued.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_RaiseEventAsync_System_String_System_String_System_String_System_Object_System_String_">DurableOrchestrationClientBase.RaiseEventAsync(String, String, String, Object, String)</a></div>
  <h5 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_RaiseEventAsync_System_String_System_String_System_String_System_Object_System_String__remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>
In order to handle the event, the target orchestration instance must be waiting for an
event named <code data-dev-comment-type="paramref" class="paramref">eventName</code> using the
<a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationContext.html#Microsoft_Azure_WebJobs_DurableOrchestrationContext_WaitForExternalEvent__1_System_String_">WaitForExternalEvent&lt;T&gt;(String)</a> API.
</p><p>
If the specified instance is not found or not running, this operation will have no effect.
</p>
</div>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/Azure/azure-functions-durable-extension/new/master/apiSpec/new?filename=Microsoft_Azure_WebJobs_DurableOrchestrationClient_RewindAsync_System_String_System_String_.md&amp;value=---%0Auid%3A%20Microsoft.Azure.WebJobs.DurableOrchestrationClient.RewindAsync(System.String%2CSystem.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/Azure/azure-functions-durable-extension/blob/master/src/WebJobs.Extensions.DurableTask/DurableOrchestrationClient.cs/#L169">View Source</a>
  </span>
  <a id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_RewindAsync_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.RewindAsync*"></a>
  <h4 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_RewindAsync_System_String_System_String_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.RewindAsync(System.String,System.String)">RewindAsync(String, String)</h4>
  <div class="markdown level1 summary"><p>Rewinds the specified failed orchestration instance with a reason.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override Task RewindAsync(string instanceId, string reason)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">instanceId</span></td>
        <td><p>The ID of the orchestration instance to rewind.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">reason</span></td>
        <td><p>The reason for rewinding the orchestration instance.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Threading.Tasks.Task</span></td>
        <td><p>A task that completes when the rewind message is enqueued.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_RewindAsync_System_String_System_String_">DurableOrchestrationClientBase.RewindAsync(String, String)</a></div>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/Azure/azure-functions-durable-extension/new/master/apiSpec/new?filename=Microsoft_Azure_WebJobs_DurableOrchestrationClient_StartNewAsync_System_String_System_String_System_Object_.md&amp;value=---%0Auid%3A%20Microsoft.Azure.WebJobs.DurableOrchestrationClient.StartNewAsync(System.String%2CSystem.String%2CSystem.Object)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/Azure/azure-functions-durable-extension/blob/master/src/WebJobs.Extensions.DurableTask/DurableOrchestrationClient.cs/#L79">View Source</a>
  </span>
  <a id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_StartNewAsync_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.StartNewAsync*"></a>
  <h4 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_StartNewAsync_System_String_System_String_System_Object_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.StartNewAsync(System.String,System.String,System.Object)">StartNewAsync(String, String, Object)</h4>
  <div class="markdown level1 summary"><p>Starts a new instance of the specified orchestrator function.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override Task&lt;string&gt; StartNewAsync(string orchestratorFunctionName, string instanceId, object input)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">orchestratorFunctionName</span></td>
        <td><p>The name of the orchestrator function to start.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">instanceId</span></td>
        <td><p>The ID to use for the new orchestration instance.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Object</span></td>
        <td><span class="parametername">input</span></td>
        <td><p>JSON-serializeable input value for the orchestrator function.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Threading.Tasks.Task</span>&lt;<span class="xref">System.String</span>&gt;</td>
        <td><p>A task that completes when the orchestration is started.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_StartNewAsync_System_String_System_String_System_Object_">DurableOrchestrationClientBase.StartNewAsync(String, String, Object)</a></div>
  <h5 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_StartNewAsync_System_String_System_String_System_Object__remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>If an orchestration instance with the specified ID already exists, the existing instance
will be silently replaced by this new instance.</p>
</div>
  <h5 class="exceptions">Exceptions</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Condition</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.ArgumentException</span></td>
        <td><p>The specified function does not exist, is disabled, or is not an orchestrator function.</p>
</td>
      </tr>
    </tbody>
  </table>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/Azure/azure-functions-durable-extension/new/master/apiSpec/new?filename=Microsoft_Azure_WebJobs_DurableOrchestrationClient_TerminateAsync_System_String_System_String_.md&amp;value=---%0Auid%3A%20Microsoft.Azure.WebJobs.DurableOrchestrationClient.TerminateAsync(System.String%2CSystem.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/Azure/azure-functions-durable-extension/blob/master/src/WebJobs.Extensions.DurableTask/DurableOrchestrationClient.cs/#L151">View Source</a>
  </span>
  <a id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_TerminateAsync_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.TerminateAsync*"></a>
  <h4 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_TerminateAsync_System_String_System_String_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.TerminateAsync(System.String,System.String)">TerminateAsync(String, String)</h4>
  <div class="markdown level1 summary"><p>Terminates a running orchestration instance.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override Task TerminateAsync(string instanceId, string reason)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">instanceId</span></td>
        <td><p>The ID of the orchestration instance to terminate.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">reason</span></td>
        <td><p>The reason for terminating the orchestration instance.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Threading.Tasks.Task</span></td>
        <td><p>A task that completes when the terminate message is enqueued.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_TerminateAsync_System_String_System_String_">DurableOrchestrationClientBase.TerminateAsync(String, String)</a></div>
  <h5 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_TerminateAsync_System_String_System_String__remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>Terminating an orchestration instance has no effect on any in-flight activity function executions
or sub-orchestrations that were started by the current orchestration instance.</p>
</div>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/Azure/azure-functions-durable-extension/new/master/apiSpec/new?filename=Microsoft_Azure_WebJobs_DurableOrchestrationClient_WaitForCompletionOrCreateCheckStatusResponseAsync_System_Net_Http_HttpRequestMessage_System_String_System_TimeSpan_System_TimeSpan_.md&amp;value=---%0Auid%3A%20Microsoft.Azure.WebJobs.DurableOrchestrationClient.WaitForCompletionOrCreateCheckStatusResponseAsync(System.Net.Http.HttpRequestMessage%2CSystem.String%2CSystem.TimeSpan%2CSystem.TimeSpan)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/Azure/azure-functions-durable-extension/blob/master/src/WebJobs.Extensions.DurableTask/DurableOrchestrationClient.cs/#L64">View Source</a>
  </span>
  <a id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_WaitForCompletionOrCreateCheckStatusResponseAsync_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.WaitForCompletionOrCreateCheckStatusResponseAsync*"></a>
  <h4 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_WaitForCompletionOrCreateCheckStatusResponseAsync_System_Net_Http_HttpRequestMessage_System_String_System_TimeSpan_System_TimeSpan_" data-uid="Microsoft.Azure.WebJobs.DurableOrchestrationClient.WaitForCompletionOrCreateCheckStatusResponseAsync(System.Net.Http.HttpRequestMessage,System.String,System.TimeSpan,System.TimeSpan)">WaitForCompletionOrCreateCheckStatusResponseAsync(HttpRequestMessage, String, TimeSpan, TimeSpan)</h4>
  <div class="markdown level1 summary"><p>Creates an HTTP response which either contains a payload of management URLs for a non-completed instance
or contains the payload containing the output of the completed orchestration.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override Task&lt;HttpResponseMessage&gt; WaitForCompletionOrCreateCheckStatusResponseAsync(HttpRequestMessage request, string instanceId, TimeSpan timeout, TimeSpan retryInterval)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Net.Http.HttpRequestMessage</span></td>
        <td><span class="parametername">request</span></td>
        <td><p>The HTTP request that triggered the current function.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">instanceId</span></td>
        <td><p>The unique ID of the instance to check.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.TimeSpan</span></td>
        <td><span class="parametername">timeout</span></td>
        <td><p>Total allowed timeout for output from the durable function. The default value is 10 seconds.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.TimeSpan</span></td>
        <td><span class="parametername">retryInterval</span></td>
        <td><p>The timeout between checks for output from the durable function. The default value is 1 second.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Threading.Tasks.Task</span>&lt;<span class="xref">System.Net.Http.HttpResponseMessage</span>&gt;</td>
        <td><p>An HTTP response which may include a 202 and location header or a 200 with the durable function output in the response body.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_WaitForCompletionOrCreateCheckStatusResponseAsync_System_Net_Http_HttpRequestMessage_System_String_System_TimeSpan_System_TimeSpan_">DurableOrchestrationClientBase.WaitForCompletionOrCreateCheckStatusResponseAsync(HttpRequestMessage, String, TimeSpan, TimeSpan)</a></div>
  <h5 id="Microsoft_Azure_WebJobs_DurableOrchestrationClient_WaitForCompletionOrCreateCheckStatusResponseAsync_System_Net_Http_HttpRequestMessage_System_String_System_TimeSpan_System_TimeSpan__remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>If the orchestration instance completes within the specified timeout, then the HTTP response payload will
contain the output of the orchestration instance formatted as JSON. However, if the orchestration does not
complete within the specified timeout, then the HTTP response will be identical to that of the
<a class="xref" href="Microsoft.Azure.WebJobs.DurableOrchestrationClientBase.html#Microsoft_Azure_WebJobs_DurableOrchestrationClientBase_CreateCheckStatusResponse_System_Net_Http_HttpRequestMessage_System_String_">CreateCheckStatusResponse(HttpRequestMessage, String)</a> API.</p>
</div>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                  <li>
                    <a href="https://github.com/Azure/azure-functions-durable-extension/new/master/apiSpec/new?filename=Microsoft_Azure_WebJobs_DurableOrchestrationClient.md&amp;value=---%0Auid%3A%20Microsoft.Azure.WebJobs.DurableOrchestrationClient%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
                  </li>
                  <li>
                    <a href="https://github.com/Azure/azure-functions-durable-extension/blob/master/src/WebJobs.Extensions.DurableTask/DurableOrchestrationClient.cs/#L22" class="contribution-link">View Source</a>
                  </li>
                </ul>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
              <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
            Copyright © .NET Foundation
            
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../styles/docfx.js"></script>
    <script type="text/javascript" src="../styles/main.js"></script>
  </body>
</html>
